| 1 | Connection handle | Input | Binary(4) |
| 2 | Transaction branch identifier | Input | Char(*) |
| 3 | Return value | Output | Binary(4) |
| 4 | Flags | Input | Binary(4) |
| 5 | Error code | I/O | Char(*) |
A transaction manager calls QxdaXAForget() to forget about a heuristically-completed transaction branch. After this call, the Transaction Branch Identifier is no longer valid. The connection does not have to be associated with the transaction in any way.
None.
The handle number of the connection on which to perform the XA operation. The connection handle must have been generated by the QxdaConnectEDRS API in the current job and activation group.
The transaction branch identifier. This identifier is generated by the transaction manager when it starts the transaction branch. The max length is 140 bytes.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Format identifier |
| 4 | 4 | BINARY(4) | Length of global transaction identifier |
| 8 | 8 | BINARY(4) | Length of branch qualifier |
| 12 | C | CHAR(128) | Transaction branch identifier |
| Format identifier: | Identifies the naming format being used. If OSI CCR naming is used, the format identifier should be set to 0. If some other format is used, a the value should be greater than 0. A value of -1 means the transaction branch identifier is null. |
| Length of global transaction identifier: | Identifies the first of at most two contiguous components comprised by the data field. This specifies the number of bytes (1-64) starting at the first byte of the data element. This is not null-terminated. |
| Length of branch qualifier: | Identifies the second of at most two contiguous components comprised by the data field. This specifies the number of bytes (1-64) starting at the first byte after the global transaction identifier. This is not null-terminated. |
| Transaction branch identifier: | Contains the data of the transaction branch identifier. |
The return value of the XA operation.
| -7 | [XAER_RMFAIL] | An error occurred that makes the resource manager unavailable. |
| -6 | [XAER_PROTO] | xa_forget() was not successful. Function was called in an improper context. |
| -5 | [XAER_INVAL] | xa_forget() was not successful. Incorrect arguments were specified. |
| -4 | [XAER_NOTA] | The specified xid is not known by the resource manager. |
| -3 | [XAER_RMERR] | xa_forget() was not successful. The resource manager detected an error when forgetting the transaction branch. |
| -2 | [XAER_ASYNC] | xa_forget() was not successful. The resource manager does not support asynchronous operations. |
| 0 | [XA_OK] | xa_forget() was successful. |
Indicator of how to perform the XA operation. The following are valid settings of flags:
| TMNOFLAGS: | x00000000 | Perform the forget operation normally. |
The structure in which to return error information. For the format of the structure, see Error code parameter.
This function may be called from the initial thread of a job only.
| Message ID | Error Message Text |
|---|---|
| CPE3418 E | Possible APAR condition or hardware failure. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFB760 E | Error encountered in &2 API, return code &1. |
The QxdaXA APIs follow the NTS (transactions with transaction scoped locks)
model. For more information regarding the NTS model, see
XA APIs.
Note: By using the code examples, you agree to the terms of the Code license and disclaimer information.
#include qxdaedrs.h
main()
{
err_t err;
Qxda_CDBI0100_t *istr = (Qxda_CDBI0100_t *)instruct;
Qxda_CDBO0100_t ostr;
int ostrsize;
XID inxid;
char gtrid[8] = "TestXA";
char bqual[6] = "Test";
inxid.formatID = 0;
inxid.gtrid_length = 6;
inxid.bqual_length = 4;
int create = XDA_SQL_TXN_CREATE;
int timeoutval = 60;
Qsq_sqlca_t myca;
int stmt1len = 21;
int flags = 0;
int ret_val;
_CPYBYTES(dtaara, gtrid, inxid.gtrid_length);
_CPYBYTES(dtaara + inxid.gtrid_length, bqual, inxid.bqual_length);
_CPYBYTES(inxid.data, dtaara, inxid.gtrid_length + inxid.bqual_length);
XID *xid = &inxid;
memset(istr, '\0', sizeof(Qxda_CDBI0100_t));
istr->Connection_Type = 'U';
memset(istr->Server_Name, ' ', 256);
istr->Commitment_Control = 'S';
_CPYBYTES(istr->Commit_Scope, "*XA ", 10);
istr->Allow_Suspend = 'Y';
memset(istr->RDB_Specified, '0', 1);
istr->SQLDA_Cache_Size = 10;
istr->Offset_Job_Data = sizeof(Qxda_CDBI0100_t);
istr->Length_Job_Data = 7;
_CPYBYTES((char *)istr + istr->Offset_Job_Data, "CONNECT", 7);
istr->Offset_Suspend_Data = istr->Offset_Job_Data + istr->Length_Job_Data;
istr->Length_Suspend_Data = 7;
memset(istr->RDB_Name, ' ', 18);
_CPYBYTES(istr->TM_Info, "TM_Name ", 10);
istr->LockTimeoutVal = 10;
ostrsize = sizeof(Qxda_CDBO0100_t);
QxdaConnectEDRS(istr, "CDBI0100", &ostr, &ostrsize,
"CDBO0100", &err);
QxdaSetXaConnection(&ostr.Connection_Handle, xid, &ret_val, &create, &timeoutval, &err);
QxdaProcessImmediateEDRS(&ostr.Connection_Handle,
"SELECT * FROM MYTABLE", &stmt1len, &myca, &err);
QxdaXAForget(&ostr.Connection_Handle, xid, &ret_val, &flags, &err);
}